//=============================================================================
// System  : MatchKit
// File    : MatchMappingArgs.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System.Reflection;

namespace MatchKit.ObjectMapping
{
	/// <summary>
	/// Provides informations about a mapping operation.
	/// </summary>
	/// <remarks>
	/// The mapping process use this class for matchable objects that implements <see cref="T:MatchKit.IMatchMappingEvents"/>.
	/// </remarks>
	/// <seealso cref="T:IMatchMappingEvents"/>
	/// <conceptualLink target="7e399cd8-5cfa-4616-a3c9-abcc9344dabc" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	public sealed class MatchMappingArgs
	{
		/// <summary>
		/// Gets the reflection member information about the currently mapping field or property.
		/// </summary>
		public MemberInfo Member { get; private set; }

		/// <summary>
		/// Gets the matched object.
		/// </summary>
		public Match Match { get; private set; }

		/// <summary>
		/// Gets or sets a value to cancel the assigning operation.
		/// </summary>
		public bool Cancel { get; set; }

		/// <summary>
		/// Gets or sets the value assigning to the member.
		/// </summary>
		public object Value { get; set; }

		internal MatchMappingArgs(MemberInfo member, Match match, object value)
		{
			Member = member;
			Match = match;
			Cancel = false;
			Value = value;
		}
	}
}
